Skip to content

Exclude unsupported files from JupyterLite build in documentation site#919

Merged
mfisher87 merged 4 commits intogeojupyter:mainfrom
arjxn-py:exclude-99-explore-nb
Sep 5, 2025
Merged

Exclude unsupported files from JupyterLite build in documentation site#919
mfisher87 merged 4 commits intogeojupyter:mainfrom
arjxn-py:exclude-99-explore-nb

Conversation

@arjxn-py
Copy link
Member

@arjxn-py arjxn-py commented Sep 5, 2025

Description

Shall close #917

Checklist

  • PR has a descriptive title and content.
  • PR description contains references to any issues the PR resolves, e.g. Resolves #XXX.
  • PR has one of the labels: documentation, bug, enhancement, feature, maintenance
  • Checks are passing.
    Failing lint checks can be resolved with:
    • pre-commit run --all-files
    • jlpm run lint

📚 Documentation preview: https://jupytergis--919.org.readthedocs.build/en/919/
💡 JupyterLite preview: https://jupytergis--919.org.readthedocs.build/en/919/lite

@github-actions
Copy link
Contributor

github-actions bot commented Sep 5, 2025

Binder 👈 Launch a Binder on branch arjxn-py/jupytergis/exclude-99-explore-nb

@arjxn-py arjxn-py added the documentation Improvements or additions to documentation label Sep 5, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Sep 5, 2025

Integration tests report: appsharing.space

@arjxn-py arjxn-py marked this pull request as draft September 5, 2025 11:57
@arjxn-py
Copy link
Member Author

arjxn-py commented Sep 5, 2025

cc @mfisher87 I have been unable to exclude these files so far!

@agriyakhetarpal
Copy link

How about using LiteBuildConfig.ignore_contents in a jupyter_lite_config.json file?

@arjxn-py
Copy link
Member Author

arjxn-py commented Sep 5, 2025

How about using LiteBuildConfig.ignore_contents in a jupyter_lite_config.json file?

Hi @agriyakhetarpal, Thanks I can try that quickly but since @mfisher87 recently added mapping to jupyterlite-sphinx jupyterlite/jupyterlite-sphinx#309 - I am thinking that it would be an optimal solution?

@mfisher87
Copy link
Member

I do like keeping the information about content inclusion/exclusion together! But it's interesting to know there's another option. Maybe jupyterlite-sphinx should use jupyter_lite_config.json as the only location for build config instead of providing a new API in conf.py? 🤔

I think I know why this isn't working, will apply a change and see if that fixes the build.

@mfisher87
Copy link
Member

That worked fine!

@mfisher87 mfisher87 marked this pull request as ready for review September 5, 2025 15:42
Copy link
Member

@mfisher87 mfisher87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ⭐

@mfisher87 mfisher87 changed the title Add jupyterlite_ignore_contents to exclude unsupported files from lite Exclude unsupported files from JupyterLite build in documentation site Sep 5, 2025
@mfisher87 mfisher87 merged commit 9f8eaf7 into geojupyter:main Sep 5, 2025
15 checks passed
@agriyakhetarpal
Copy link

Maybe jupyterlite-sphinx should use jupyter_lite_config.json as the only location for build config instead of providing a new API in conf.py? 🤔

I think the API is fine in this case, as we have a jupyterlite_contents option and the jupyterlite_ignore_contents option complements it pretty well! However, I think we should indeed have some discussion on which options should make it to conf.py and which ones shouldn't – for advanced options and configuration, we already support jupyterlite_build_command_args.

HaudinFlorence pushed a commit to HaudinFlorence/jupytergis that referenced this pull request Jan 28, 2026
geojupyter#919)

Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Exclude 99-Explore_data_in_a_map from the lite deployment

3 participants